home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / dormbr.z / dormbr
Encoding:
Text File  |  2002-10-03  |  6.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. DDDDOOOORRRRMMMMBBBBRRRR((((3333SSSS))))                                                          DDDDOOOORRRRMMMMBBBBRRRR((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DORMBR - VECT = 'Q', DORMBR overwrites the general real M-by-N matrix C
  10.      with SIDE = 'L' SIDE = 'R' TRANS = 'N'
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE DORMBR( VECT, SIDE, TRANS, M, N, K, A, LDA, TAU, C, LDC, WORK,
  14.                         LWORK, INFO )
  15.  
  16.          CHARACTER      SIDE, TRANS, VECT
  17.  
  18.          INTEGER        INFO, K, LDA, LDC, LWORK, M, N
  19.  
  20.          DOUBLE         PRECISION A( LDA, * ), C( LDC, * ), TAU( * ), WORK( *
  21.                         )
  22.  
  23. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  24.      These routines are part of the SCSL Scientific Library and can be loaded
  25.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  26.      directs the linker to use the multi-processor version of the library.
  27.  
  28.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  29.      4 bytes (32 bits). Another version of SCSL is available in which integers
  30.      are 8 bytes (64 bits).  This version allows the user access to larger
  31.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  32.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  33.      only one of the two versions; 4-byte integer and 8-byte integer library
  34.      calls cannot be mixed.
  35.  
  36. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  37.      If VECT = 'Q', DORMBR overwrites the general real M-by-N matrix C with
  38.      SIDE = 'L' SIDE = 'R' TRANS = 'N': Q * C C * Q TRANS = 'T':      Q**T * C
  39.      C * Q**T
  40.  
  41.      If VECT = 'P', DORMBR overwrites the general real M-by-N matrix C with
  42.                      SIDE = 'L'     SIDE = 'R'
  43.      TRANS = 'N':      P * C          C * P
  44.      TRANS = 'T':      P**T * C       C * P**T
  45.  
  46.      Here Q and P**T are the orthogonal matrices determined by DGEBRD when
  47.      reducing a real matrix A to bidiagonal form: A = Q * B * P**T. Q and P**T
  48.      are defined as products of elementary reflectors H(i) and G(i)
  49.      respectively.
  50.  
  51.      Let nq = m if SIDE = 'L' and nq = n if SIDE = 'R'. Thus nq is the order
  52.      of the orthogonal matrix Q or P**T that is applied.
  53.  
  54.      If VECT = 'Q', A is assumed to have been an NQ-by-K matrix:  if nq >= k,
  55.      Q = H(1) H(2) . . . H(k);
  56.      if nq < k, Q = H(1) H(2) . . . H(nq-1).
  57.  
  58.      If VECT = 'P', A is assumed to have been a K-by-NQ matrix:  if k < nq, P
  59.      = G(1) G(2) . . . G(k);
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDOOOORRRRMMMMBBBBRRRR((((3333SSSS))))                                                          DDDDOOOORRRRMMMMBBBBRRRR((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      if k >= nq, P = G(1) G(2) . . . G(nq-1).
  75.  
  76.  
  77. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  78.      VECT    (input) CHARACTER*1
  79.              = 'Q': apply Q or Q**T;
  80.              = 'P': apply P or P**T.
  81.  
  82.      SIDE    (input) CHARACTER*1
  83.              = 'L': apply Q, Q**T, P or P**T from the Left;
  84.              = 'R': apply Q, Q**T, P or P**T from the Right.
  85.  
  86.      TRANS   (input) CHARACTER*1
  87.              = 'N':  No transpose, apply Q  or P;
  88.              = 'T':  Transpose, apply Q**T or P**T.
  89.  
  90.      M       (input) INTEGER
  91.              The number of rows of the matrix C. M >= 0.
  92.  
  93.      N       (input) INTEGER
  94.              The number of columns of the matrix C. N >= 0.
  95.  
  96.      K       (input) INTEGER
  97.              If VECT = 'Q', the number of columns in the original matrix
  98.              reduced by DGEBRD.  If VECT = 'P', the number of rows in the
  99.              original matrix reduced by DGEBRD.  K >= 0.
  100.  
  101.      A       (input) DOUBLE PRECISION array, dimension
  102.              (LDA,min(nq,K)) if VECT = 'Q' (LDA,nq)        if VECT = 'P' The
  103.              vectors which define the elementary reflectors H(i) and G(i),
  104.              whose products determine the matrices Q and P, as returned by
  105.              DGEBRD.
  106.  
  107.      LDA     (input) INTEGER
  108.              The leading dimension of the array A.  If VECT = 'Q', LDA >=
  109.              max(1,nq); if VECT = 'P', LDA >= max(1,min(nq,K)).
  110.  
  111.      TAU     (input) DOUBLE PRECISION array, dimension (min(nq,K))
  112.              TAU(i) must contain the scalar factor of the elementary reflector
  113.              H(i) or G(i) which determines Q or P, as returned by DGEBRD in
  114.              the array argument TAUQ or TAUP.
  115.  
  116.      C       (input/output) DOUBLE PRECISION array, dimension (LDC,N)
  117.              On entry, the M-by-N matrix C.  On exit, C is overwritten by Q*C
  118.              or Q**T*C or C*Q**T or C*Q or P*C or P**T*C or C*P or C*P**T.
  119.  
  120.      LDC     (input) INTEGER
  121.              The leading dimension of the array C. LDC >= max(1,M).
  122.  
  123.      WORK    (workspace/output) DOUBLE PRECISION array, dimension (LWORK)
  124.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDOOOORRRRMMMMBBBBRRRR((((3333SSSS))))                                                          DDDDOOOORRRRMMMMBBBBRRRR((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LWORK   (input) INTEGER
  141.              The dimension of the array WORK.  If SIDE = 'L', LWORK >=
  142.              max(1,N); if SIDE = 'R', LWORK >= max(1,M).  For optimum
  143.              performance LWORK >= N*NB if SIDE = 'L', and LWORK >= M*NB if
  144.              SIDE = 'R', where NB is the optimal blocksize.
  145.  
  146.              If LWORK = -1, then a workspace query is assumed; the routine
  147.              only calculates the optimal size of the WORK array, returns this
  148.              value as the first entry of the WORK array, and no error message
  149.              related to LWORK is issued by XERBLA.
  150.  
  151.      INFO    (output) INTEGER
  152.              = 0:  successful exit
  153.              < 0:  if INFO = -i, the i-th argument had an illegal value
  154.  
  155. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  156.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  157.  
  158.      This man page is available only online.
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.